♻️ common http API interface for long_running_tasks
#7843
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 14 commits
June 5, 2025 15:35
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #7843 +/- ##
==========================================
+ Coverage 87.89% 87.96% +0.07%
==========================================
Files 1837 1640 -197
Lines 71032 66447 -4585
Branches 1219 912 -307
==========================================
- Hits 62433 58450 -3983
+ Misses 8256 7734 -522
+ Partials 343 263 -80
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
added 9 commits
June 6, 2025 10:46
GitHK
changed the title
long_running_tasks
GitHK
changed the title
long_running_taskslong_running_tasks
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the long running tasks API by unifying the HTTP interface for both aiohttp and FastAPI servers and delegating core implementation to a common servicelib module. Key changes include:
- Standardizing configuration values to use timedelta instead of raw seconds.
- Refactoring API endpoints and client/server modules to use shared http_endpoint_responses.
- Removing deprecated or unused code and updating tests to align with the new interface.
Reviewed Changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| services/director-v2/tests/integration/02/test_dynamic_sidecar_nodeports_integration.py | Updated import paths for FastAPI client and periodic_task_result. |
| packages/service-library/tests/long_running_tasks/test_long_running_tasks_task.py | Changed datetime import usage and updated configuration to use timedelta. |
| packages/service-library/src/servicelib/long_running_tasks/task.py | Refactored TasksManager usage to support timedelta and replaced the close method with teardown. |
| packages/service-library/src/servicelib/long_running_tasks/models.py | Introduced TaskGetWithoutHref and updated default factory for timestamps. |
| packages/service-library/src/servicelib/long_running_tasks/http_endpoint_responses.py | Added helper functions to centralize HTTP endpoint responses. |
| packages/service-library/src/servicelib/long_running_tasks/constants.py | Added new constants file for default poll and stale task intervals. |
| packages/service-library/src/servicelib/fastapi/long_running_tasks/* | Updated client, server, routes, and error handlers to use the new configuration and common responses. |
| packages/service-library/src/servicelib/aiohttp/long_running_tasks/* | Refactored server, client, routes, and dependencies to align with the new interface. |
| packages/models-library/src/models_library/api_schemas_long_running_tasks/tasks.py | Adjusted TaskGet hierarchy by splitting into TaskGetWithoutHref and extending TaskGet. |
| api/specs/web-server/* | Updated response_model to Any for legacy endpoints. |
packages/service-library/src/servicelib/fastapi/long_running_tasks/_error_handlers.py
Show resolved
Hide resolved
giancarloromeo
approved these changes
Jun 11, 2025
sanderegg
approved these changes
Jun 11, 2025
packages/models-library/src/models_library/api_schemas_long_running_tasks/tasks.py
Outdated
Show resolved
Hide resolved
packages/service-library/src/servicelib/aiohttp/long_running_tasks/_dependencies.py
Outdated
Show resolved
Hide resolved
packages/service-library/src/servicelib/aiohttp/long_running_tasks/_routes.py
Outdated
Show resolved
Hide resolved
packages/service-library/src/servicelib/aiohttp/long_running_tasks/_routes.py
Show resolved
Hide resolved
packages/service-library/src/servicelib/long_running_tasks/task.py
Outdated
Show resolved
Hide resolved
added 10 commits
June 12, 2025 08:30
|
pcrespov
approved these changes
Jun 12, 2025
packages/service-library/src/servicelib/aiohttp/long_running_tasks/_dependencies.py
Show resolved
Hide resolved
Contributor
Author
|
@Mergifyio queue |
Contributor
✅ The pull request has been merged automaticallyThe pull request has been merged automatically at c7b7878 |
This was referenced Jun 17, 2025
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What do these changes do?
Aligns the public interface exposed by an
aiohttporFastAPIserver for managing the lifecycle of a long running task.Also delegates as much as possible of the implementation inside the common
servicelib/long_running_tasksinstead of the individualservicelib/aiohttp/long_running_tasksandservicelib/fastapi/long_running_tasksmodules.Removes some unused code
Related issue/s
How to test
Dev-ops